package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendanceSallaryTemplateAddDTO;
import org.jsola.hr.dto.AttendanceSallaryTemplateUpdateDTO;
import org.jsola.hr.query.AttendanceSallaryTemplateQuery;
import org.jsola.hr.vo.AttendanceSallaryTemplateListVO;
import org.jsola.hr.vo.AttendanceSallaryTemplateVO;
import org.springframework.core.io.Resource;
import org.springframework.http.ResponseEntity;

import java.util.List;

/**
 * 考勤工资模板表
 *
 * @author zhr
 */
@Api(tags = "hr-考勤工资模板表")
public interface IAttendanceSallaryTemplateControllerAPI {

    /**
     * 下载考勤工资excel模板
     *
     * @return 文件
     */
    @ApiOperation(value = "下载考勤工资excel模板")
    @ApiImplicitParams({
    })
    ResponseEntity<Resource> downloadTemplate();

    /**
     * 新增考勤工资模板表
     * @param attendanceSallaryTemplateAddDTO 考勤工资模板表新增实体
     * @return 考勤工资模板表展示对象
     */
    @ApiOperation(value = "新增考勤工资模板表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceSallaryTemplateAddDTO", dataType = "AttendanceSallaryTemplateAddDTO", value = "新增考勤工资模板表", paramType = "body")
    })
    Result<AttendanceSallaryTemplateVO> save(AttendanceSallaryTemplateAddDTO attendanceSallaryTemplateAddDTO);


    /**
     * 修改考勤工资模板表
     * @param attendanceSallaryTemplateUpdateDTO 考勤工资模板表
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤工资模板表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceSallaryTemplateUpdateDTO", dataType = "AttendanceSallaryTemplateUpdateDTO", value = "修改考勤工资模板表", paramType = "body")
    })
    Result<Integer> update(AttendanceSallaryTemplateUpdateDTO attendanceSallaryTemplateUpdateDTO);




    /**
     * 删除单个考勤工资模板表，彻底删除
     * @param attendanceSallaryTemplateId 考勤工资模板表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤工资模板表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceSallaryTemplateId", dataType = "String", value = "考勤工资模板表id", paramType = "path")
    })
    Result<Integer> delete(String attendanceSallaryTemplateId);


    /**
     * 批量删除考勤工资模板表，彻底删除
     * @param attendanceSallaryTemplateIds 考勤工资模板表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤工资模板表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceSallaryTemplateIds", dataType = "String[]", value = "考勤工资模板表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendanceSallaryTemplateIds);


    /**
     * 根据考勤工资模板表id查询考勤工资模板表详情
     * @param attendanceSallaryTemplateId 考勤工资模板表id
     * @return 考勤工资模板表详情
     */
    @ApiOperation(value="根据考勤工资模板表id查询考勤工资模板表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceSallaryTemplateId", dataType = "String", value = "考勤工资模板表id", paramType = "path")
    })
    Result<AttendanceSallaryTemplateVO> findById(String attendanceSallaryTemplateId);


    /**
     * 查询考勤工资模板表
     * @param attendanceSallaryTemplateQuery 考勤工资模板表查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤工资模板表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceSallaryTemplateQuery", dataType = "AttendanceSallaryTemplateQuery", value = "考勤工资模板表查询参数", paramType = "query")
    })
    Result<List<AttendanceSallaryTemplateListVO>> listAll(AttendanceSallaryTemplateQuery attendanceSallaryTemplateQuery);


     /**
     * 分页查询考勤工资模板表
     * @param attendanceSallaryTemplateQuery 考勤工资模板表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤工资模板表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceSallaryTemplateQuery", dataType = "AttendanceSallaryTemplateQuery", value = "考勤工资模板表查询参数", paramType = "query")
    })
    Result<Page<AttendanceSallaryTemplateListVO>> page(AttendanceSallaryTemplateQuery attendanceSallaryTemplateQuery);


}

